home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr10 / autrd201.zip / MANUAL.DOC < prev    next >
Text File  |  1993-06-16  |  88KB  |  1,991 lines

  1.    ╔═════════════════════════════════════════════════════════════════════╗
  2.    ║                           ┌──────────┐                              ║
  3.    ║                           │ AUTOREAD │                              ║
  4.    ║                           └──────────┘                              ║
  5.    ║                                                                     ║
  6.    ║       A program to allow easy reading of large text files           ║
  7.    ║                          on a computer                              ║
  8.    ║                                                                     ║
  9.    ║                              MANUAL                                 ║
  10.    ║                                                                     ║
  11.    ║                                                                     ║
  12.    ║                      Author: David R Grigg                          ║
  13.    ║               A Product of Rightword Enterprises.                   ║
  14.    ║                 (C) Copyright David R Grigg 1991                    ║
  15.    ║                                                                     ║
  16.    ║                                                                     ║
  17.    ║                           Version 2.00                              ║
  18.    ║                          December 1992.                             ║
  19.    ║                                                                     ║
  20.    ║                 ┌─────────────────────────────┐                     ║
  21.    ║                 │       CONTACT DETAILS:      │                     ║
  22.    ║                 │       David R. Grigg,       │                     ║
  23.    ║                 │       1556 Main Road,       │                     ║
  24.    ║                 │          Research,          │                     ║
  25.    ║                 │        Victoria 3095,       │                     ║
  26.    ║                 │          AUSTRALIA.         │                     ║
  27.    ║                 │                             │                     ║
  28.    ║                 │   Compuserve: [76264,2530]  │                     ║
  29.    ║                 └─────────────────────────────┘                     ║
  30.    ║                                                                     ║
  31.    ╚═════════════════════════════════════════════════════════════════════╝
  32.  
  33.  
  34.                                                     Autoread Manual  -i-
  35.  
  36.  
  37.   DISCLAIMER
  38.   ──────────
  39.   While every effort has been made to free AUTOREAD from errors, and I
  40.   can't imagine how AUTOREAD could cause you any problems, as a matter
  41.   of prudent legality, please heed the following notice:
  42.  
  43.   I, David R Grigg, accept NO RESPONSIBILITY OR LIABILITY for any damage
  44.   that may be caused to your computer, disks or data by the use of
  45.   AUTOREAD.
  46.  
  47.   If this makes you nervous, try AUTOREAD out on a floppy disk first.  As
  48.   a matter of good practice you should always keep regular backups of
  49.   important files.
  50.  
  51.                                                    Autoread Manual  -ii-
  52.  
  53.  
  54.   CONTENTS
  55.   ────────
  56. │ DISCLAIMER ....................................................  i
  57. │ 1:  Introduction ..............................................  1
  58. │ 2:  Shareware Notice ..........................................  3
  59. │ 3:  Installing AUTOREAD .......................................  4
  60. │ 4:  Files Created by AUTOREAD .................................  5
  61. │ 5:  The AUTOREAD screen .......................................  6
  62. │   5.1  Menus and Selecting Choices ............................  6
  63. │   5.2  The File Open Dialog Box ...............................  6
  64. │   5.3  The Document Window ....................................  7
  65. │   5.4  Window Highlighting ....................................  7
  66. │ 6. A Brief Tour of the AUTOREAD Menu Bar ......................  9
  67. │   6.1  The = Menu .............................................  9
  68. │   6.2  The File Menu ..........................................  9
  69. │   6.3  The Document Menu ......................................  9
  70. │   6.3  The Chapter Menu .......................................  9
  71. │   6.4  The Keywords Menu .....................................  10
  72. │   6.5  The Bookmarks Menu ....................................  10
  73. │   6.6  The Search Menu .......................................  10
  74. │   6.7  The Utilities Menu ....................................  11
  75. │ 7:  Document Menu ............................................  12
  76. │   7.1  View (Home) ...........................................  12
  77. │   7.2  Top(^Home) ............................................  12
  78. │   7.3  Middle ................................................  12
  79. │   7.4  Bottom (^End) .........................................  12
  80. │   7.5  Line Number ...........................................  13
  81. │   7.6  Page Number ...........................................  13
  82. │   7.7  Odd Page Set ..........................................  13
  83. │   7.8  Even Page Set .........................................  14
  84. │   7.9  Preferences ...........................................  14
  85. │      7.9.1  Chapter Sort Order ...............................  14
  86. │      7.9.2  Show Level Prefixes and Level Prefix Symbol ......  15
  87. │      7.9.3  Offset Display ...................................  15
  88. │      7.9.4  Save Last Session ................................  15
  89. │      7.9.5  Start at Last Session ............................  15
  90. │      7.9.6.  Save Bookmarks ..................................  15
  91. │ 8:  Chapters Menu ............................................  16
  92. │   8.1  View (F2) .............................................  16
  93. │   8.2  Find(Enter) ...........................................  16
  94. │   8.3  Add Current Line (Ins or Alt-A) .......................  17
  95. │   8.4  Delete ................................................  17
  96. │   8.5  Edit ..................................................  17
  97. │   8.6  Promote and Demote ....................................  17
  98. │   8.7  Clear .................................................  17
  99. │   8.8  Make ..................................................  17
  100. │   8.9  Textual Make ..........................................  18
  101. │      8.9.1  A Textual Make Example ...........................  18
  102. │   8.10 Procedural Make .......................................  19
  103. │   8.11  UpperCase Make .......................................  20
  104. │   8.12  Problems with Make ...................................  20
  105. │   8.13  The Stand-Alone Make Utility .........................  21
  106. │      8.13.1  C - Clear Chapters ..............................  21
  107. │      8.13.2  T - Textual Make ................................  22
  108. │      8.13.3  N - Numeric Procedural Make .....................  22
  109. │      8.13.4  A - Alphabetical Procedural Make ................  22
  110. │      8.13.5  U - UpperCase Make ..............................  22
  111.  
  112.                                                         Autoread Manual  -iii-
  113.  
  114. │      8.13.6  Example Make File: ..............................  22
  115. │      8.13.8  An Important Note! ..............................  22
  116. │ 9:  Keywords Menu ............................................  23
  117. │   9.1  View (F3) .............................................  23
  118. │   9.2  Find (Enter) ..........................................  23
  119. │   9.3  Add (Ins) .............................................  23
  120. │   9.4  Delete (Del) ..........................................  23
  121. │   9.5  Edit (Ctrl-F3) ........................................  23
  122. │ 10:  Bookmarks Menu ..........................................  24
  123. │   10.1  View (F4) ............................................  24
  124. │   10.2  Find (Enter) .........................................  24
  125. │   10.3  Add (Ins) ............................................  24
  126. │   10.4 Delete (Del) ..........................................  24
  127. │   10.5 Edit (Ctrl-F4) ........................................  25
  128. │   10.6  Function Key Setting & Finding Marks .................  25
  129. │ 11:  Find Menu ...............................................  26
  130. │   11.1  Find Text (F5) .......................................  26
  131. │   11.2  Last Find (F6) .......................................  26
  132. │   11.3  Find In Chapter (Ctrl-F5) ............................  26
  133. │   11.4  Last Chapter Find (Ctrl-F6) ..........................  27
  134. │ 12:  Utilities Menu ..........................................  28
  135. │   12.1  Screen Mode ..........................................  28
  136. │   12.2  Directories ..........................................  28
  137. │   12.3  Output Text ..........................................  28
  138. │      12.3.1  Screen ..........................................  29
  139. │      12.3.2  Chapter .........................................  29
  140. │      12.3.3  Lines ...........................................  29
  141. │      12.3.4  Page Break ......................................  29
  142. │ 13:  The Read-Only Version ...................................  30
  143. │ 14:  Acknowledgements ........................................  31
  144. │ 15:  Version History .........................................  32
  145. │    15.1  Updates .............................................  32
  146. │ APPENDIX A: FUNCTION KEY SUMMARY .............................  34
  147. │ APPENDIX B: COMMAND-LINE OPTIONS .............................  35
  148. │ APPENDIX C: THE .ARD FILE FORMAT .............................  36
  149. │ APPENDIX D: LIMITATIONS OF AUTOREAD ..........................  38
  150. │ APPENDIX E: MUSINGS ON THE WRITING OF MANUALS ................  39
  151. │ APPENDIX F: RAVE REVIEWS AND UNSOLICITED TESTIMONIALS! .......  40
  152.  
  153.                                                    Autoread Manual   -1-
  154.  
  155.  
  156.   1:  Introduction
  157.   ════════════════
  158.  
  159.   I wrote this program because I often find myself in the situation of
  160.   having a large text file on my computer's hard disk which I am using
  161.   because it has some kind of information of value to me.  Usually it is
  162.   the manual for a shareware program.
  163.  
  164.   I adore shareware.  I think the concept of trusting people to pay a
  165.   modest fee for software they genuinely find useful is terrific.  And I
  166.   use a lot of shareware (and pay the appropriate registration fees).
  167.  
  168.   But the manuals for most shareware programs are distributed as a text
  169.   file unless you pay extra (and I generally don't).  So I end up with
  170.   very useful manuals in a very NON-useful form: a large text file on my
  171.   hard disk.
  172.  
  173.   Sure, I can print out the manual, but this can consume enormous
  174.   amounts of time, paper and printer ribbons (the QEDIT manual, for
  175.   example, is some 5500 lines long).  And besides, I can never find the
  176.   manual when I want it.  And even if I can, finding the information I
  177.   want can be very hard.
  178.  
  179.   Aren't computers supposed to make life easier?  Yet reading a document
  180.   on a computer screen is still extremely primitive.  Certainly you can
  181.   use a useful utility like LIST, but this is still missing something.
  182.   It's hard to navigate around in a large text file, to find the next
  183.   chapter, or to locate key words.  Using the FIND utility in such
  184.   programs is some help, of course, but you have to type in the key
  185.   word, and hope you have spelt and punctuated it properly.
  186.  
  187.   AUTOREAD is my attempt to fill this perceived gap.  It works very much
  188.   like LIST, but it allows you to progressively establish landmarks in
  189.   the text and to go instantly to them.
  190.  
  191.   AUTOREAD allows the creation of several kinds of 'landmarks':
  192.  
  193.                  * Chapter Stops
  194.  
  195.                  * Predefined Keywords
  196.  
  197.                  * Temporary Bookmarks
  198.  
  199.   These are all available via separate windows for easiest possible use.
  200.  
  201.   What all this means is that you can very easily create a comprehensive
  202.   index to a particular text file, enabling you to instantly find the
  203.   section or information you are looking for.  It makes reading a text
  204.   file on your computer as easy as reading a hard copy, and in some
  205.   respects easier.
  206.  
  207.   Another extremely valuable use of AUTOREAD is for the creation of on-
  208.   line help facilities.  Several companies have purchased  site-license
  209.   agreements for AUTOREAD for just this purpose.  The command-line Find
  210.   Text function means that you can start up AUTOREAD and instantly zip
  211.   to the particular topic you are interested in.  A read-only version of
  212.   AUTOREAD, called READAUTO, is available so you can create such a help
  213.  
  214.                                                    Autoread Manual   -2-
  215.  
  216.   system but prevent your users from messing up your set-up.
  217.  
  218.   Note that one of the very best features of this latest release of
  219.   AUTOREAD (in my view) is its ability to handle VERY large documents,
  220.   possibly up to 80MB in size, though indexing such a document might
  221.   take a while...
  222.  
  223.                                                    Autoread Manual   -3-
  224.  
  225.  
  226.  
  227.   2:  Shareware Notice
  228.   ════════════════════
  229.  
  230.   AUTOREAD took a lot of effort to create.  And I am still working on
  231.   improving it.
  232.  
  233.   Please note that AUTOREAD is not, never has been, and never will be
  234.   free or public domain software.  It is shareware.
  235.  
  236.   The shareware concept is extremely simple.  If you obtain a copy of a
  237.   shareware program, find it useful to you, and wish to continue using
  238.   it, you must send the requested shareware fee to the program author.
  239.  
  240.   Shareware relies entirely on trust.  But it is a concept which has
  241.   allowed the creation and distribution of a large body of excellent
  242.   software at very low cost.
  243.  
  244.   If you find AUTOREAD of use, please print out and fill in the enclosed
  245.   LICENSE.DOC document, and send it with the requested $30 shareware fee
  246.   to:
  247.  
  248.                             David R Grigg,
  249.                             1556 Main Road,
  250.                             Research,
  251.                             Victoria 3095
  252.                             Australia.
  253.  
  254.   In return, you will receive the current version of AUTOREAD,
  255.   registered and free of the annoying opening shareware message, and
  256.   also free from several limitations on size of document, number of
  257.   chapters and keywords which are built into the shareware version (I've
  258.   got to make a living somehow!).
  259.  
  260.   For those in the US: personal cheques are acceptable.
  261.  
  262.   NOTE:
  263.  
  264.   Most commercial software forbids you to make copies of it.  But because
  265.   AUTOREAD is shareware software, you are positively ENCOURAGED to share
  266.   copies of AUTOREAD around, copy it for your friends, upload it to
  267.   bulletin boards, etc.  The only stipulations are that all those who
  268.   use AUTOREAD for longer than a trial period of 14 days must pay the
  269.   required shareware fee, and that AUTOREAD must be distributed with all
  270.   the associated files, being:
  271.  
  272.                        AUTOREAD.EXE
  273.                        MANUAL.DOC
  274.                        MANUAL.ARI
  275.                        MANUAL.ARD
  276.                        LICENSE.DOC
  277.                        README.BAT
  278.                        CHAPMAKE.EXE
  279.  
  280.                                                    Autoread Manual   -4-
  281.  
  282.  
  283.   3:  Installing AUTOREAD
  284.   ═══════════════════════
  285.  
  286.   AUTOREAD is extremely easy to install.
  287.  
  288.   The only file absolutely necessary to operating AUTOREAD is
  289.   AUTOREAD.EXE, which you should place either into the same directory as
  290.   the documents you wish to use it on, or (especially if you have a hard
  291.   disk) into a directory which is listed in your DOS PATH command (this
  292.   is usually specified in your AUTOEXEC.BAT file).
  293.  
  294.   Many hard disk users have a directory called \TOOLS on their hard
  295.   disk.  This is a good place for AUTOREAD.
  296.  
  297.   NOTE: if you are upgrading from version 1.10 or before, you may care to
  298.   install version 2.00 in a different directory from your current version,
  299.   until you have tried it out.  There are a lot of changes in this version,
  300.   and some features omitted.  On balance, I believe this version is much
  301.   better than the earlier versions, but it would be as well for you to keep
  302.   your old version of AUTOREAD until you have made sure you are happy with
  303.   the new version.
  304.  
  305.   To use AUTOREAD on a particular text file (as an example, say a file
  306.   called MANUAL.DOC), you would enter the following at the DOS prompt:
  307.  
  308.             AUTOREAD MANUAL.DOC
  309.  
  310.   If you don't enter the file name, AUTOREAD will open up, and you can
  311.   use the File Open menu choice to select the file you want.
  312.   Alternatively, if you start up with a command line like this:.
  313.  
  314.             AUTOREAD *.TXT
  315.  
  316.   ...AUTOREAD will start up by showing you the File Open dialog box,
  317.   showing all the files that fit the specification you gave on the
  318.   command line.
  319.  
  320.   NOTE:
  321.  
  322.   If you don't enter a file extension (e.g.  the .DOC above), then
  323.   AUTOREAD will attempt to find a file with the name you have given it,
  324.   with either of the following extensions:
  325.  
  326.           .DOC
  327.           .TXT
  328.  
  329.   If it still can't find the file, it will give up with an error
  330.   message.
  331.  
  332.                                                    Autoread Manual   -5-
  333.  
  334.  
  335.  
  336.   4:  Files Created by AUTOREAD
  337.   ═════════════════════════════
  338.  
  339.   AUTOREAD maintains at least two different files of its own for every
  340.   text file that you use it on, and in some circumstances three.
  341.  
  342.   If you used it on a document called MANUAL.DOC, for example, AUTOREAD
  343.   would create the following files:
  344.  
  345.            MANUAL.ARI
  346.            MANUAL.ARD
  347.   ...and if you chose Save Last Session or Save Bookmarks in the
  348.   Preferences dialog box (see page 14), the following file:
  349.            MANUAL.ARB
  350.  
  351.   Unless you have changed the text-file since you last read it, the .ARI
  352.   file will be created only the first time you use AUTOREAD on the text
  353.   file.  The .ARD file, however, may be rewritten many times as you add
  354.   data or alter preferences.
  355.  
  356.   The .ARI file is an index of the starting points of each line of the
  357.   text file, and enables AUTOREAD to very speedily locate parts of the
  358.   file.  If it offends you to have a lot of additional files in a
  359.   directory, you can delete this file, but then AUTOREAD will need to
  360.   recreate it each time you access the text file that it indexes.
  361.  
  362.   The .ARD file contains such data as your preferences for this
  363.   document, a list of chapter stops and their starting lines, a list of
  364.   keywords, and some other information.  Note that the .ARD file is an
  365.   ordinary text file, which means that you can use a text editor to
  366.   manipulate it directly.  (See APPENDIX C on page 35 for details).
  367.  
  368.   Users of versions prior to version 2.00 may wish to note that there
  369.   have been some minor changes to the format of the .ARD file, most
  370.   importantly in the order in which information is stored in the file,
  371.   and in the addition of some new data sections.
  372.  
  373.   The .ARB file, saved only if certain preferences are set for the
  374.   document, contains any  bookmarks you have created, and/or the Last
  375.   Session line number; that is, the line of the document you were
  376.   viewing when you closed the document (which is stored as bookmark #0).
  377.  
  378.   From version 2.00, you can dictate where (ie, in what file directory)
  379.   these various files are created.  This means you can now use AUTOREAD
  380.   on a file which is located on a write-protected disk, even for example
  381.   on a CD-ROM, by having the writable files elsewhere.  However, unless
  382.   you specifically tell AUTOREAD otherwise, it will look for these files
  383.   in the same directory as the source document.
  384.  
  385.                                                    Autoread Manual   -6-
  386.  
  387.  
  388.  
  389.   5:  The AUTOREAD screen
  390.   ═══════════════════════
  391.  
  392.   5.1: Menus and Selecting Choices
  393.   ──────────────────────────────────────────────────────────────────────
  394.   You may well be familiar with using programs with pull-down menus and
  395.   moveable windows, either under Microsoft Windows, or programs running
  396.   under DOS which use the same kind of interface, in which case you can
  397.   probably skip this section of the manual.
  398.  
  399.   If you are not using AUTOREAD to read this manual, please start it up
  400.   now by typing:
  401.                   AUTOREAD MANUAL
  402.   at the command-line.
  403.  
  404.   Note the Menu Bar at the top line of the screen, and the Status Line
  405.   at the bottom.  At any time, you can pull down a menu from any of the
  406.   choices on the Menu Bar, in any one of several ways:
  407.  
  408.   *    By clicking on the menu choice with the mouse, if you are using one;
  409.   *    By holding down the Alt key and then pressing the first letter of
  410.        your desired choice;
  411.   *    By pressing F10 to highlight the first choice on the menu bar,
  412.        and then using the arrow keys to move across choices, and Enter to
  413.        select one.
  414.  
  415.   Once you have a menu open, you can select a choice either by:
  416.   *    Clicking on the choice with the mouse;
  417.   *    Using the arrow keys to select the item you want and then
  418.        pressing Enter;
  419.   *    Pressing the key corresponding to the letter in the item which is
  420.        highlighted in red.
  421.   *    Pressing the key shown to the right of the choice - this is
  422.        usually called the "hot key" for the action, and not all choices have
  423.        them.  You can also often use the hot key when the menu is not opened
  424.        up.
  425.  
  426.   You will note that many choices are "greyed out" until you open a
  427.   document.  These represent choices which are invalid for the current
  428.   state of the program.  Obviously, you cannot close a document until
  429.   you have opened one!  Note also that the current version of AUTOREAD
  430.   only allows one document to be open at a time, and so once you have
  431.   opened a document, the Open choice on the file menu is greyed out.
  432.  
  433.   5.2: The File Open Dialog Box
  434.   ──────────────────────────────────────────────────────────────────────
  435.   When you chose Open from the File menu, a dialog box will appear.
  436.   (A dialog box is just an area on the screen that lets you make choices).
  437.  
  438.   Press the TAB key a few times.  You will notice that different parts
  439.   of the box get highlighted.  While a section is highlighted, you can
  440.   either enter text, or make some kind of selection.  Of course, using a
  441.   mouse, all you need to is click on the area which wish to use.  Note
  442.   in particular the green, drop-shadowed "buttons".  You can either
  443.   click on these, or TAB the highlight to them and then press Enter.
  444.  
  445.                                                    Autoread Manual   -7-
  446.  
  447.   With the Open File dialog, you can either enter the file name you want
  448.   directly in the text input field, or select the wanted file in the
  449.   scrolling file list.  Then just press Enter, or click on the "Open"
  450.   button to open the nominated file.
  451.  
  452.  
  453.   5.3: The Document Window
  454.   ─────────────────────────────────────────────────────────────────────
  455.   Once you have opened a file, you may see a message on the Status Line
  456.   showing that AUTOREAD is busy creating an index.  When this process is
  457.   finished, you may see a couple of boxes appear very briefly before
  458.   disappearing and being replaced by the Document Window.  Don't worry
  459.   about these boxes, which may vanish so fast they appear just to be
  460.   flashes on your screen - AUTOREAD is just creating windows for
  461.   chapters, keywords and bookmarks, and then hiding them to get them out
  462.   of your way.
  463.  
  464.   There are several points to note about the Document Window.  Firstly, the
  465.   close button at the top left of the window, a dot of colour with square
  466.   brackets around it.  Clicking on this point will close the window (and for
  467.   the Document Window, this will also close the document and other windows).
  468.   Without a mouse, just press the ESC key to close a window.
  469.  
  470.   Secondly, note the scroll bars at the right hand side and bottom of
  471.   the Document window.  Clicking on the arrows will scroll the document
  472.   in the direction indicated.  You can also click in the areas above and
  473.   below the position indicator, which will cause the document to scroll
  474.   up or down a screenfull at a time.  (Note that in this version, you
  475.   can't use the mouse to move the position indicator yourself - this is
  476.   a feature which will be included in later versions).  Without a mouse,
  477.   you can just use the arrow keys or Page Up and Page Down keys to
  478.   scroll the document.
  479.  
  480.   If you have a mouse, you can also re-size and re-position the window
  481.   on the screen.  This may be useful when you have the Chapter or other
  482.   windows also open.
  483.  
  484.   Holding down the Control (CTRL) key on your keyboard and pressing HOME
  485.   will go to the start of the file.
  486.  
  487.   Holding down the Control (CTRL) key on your keyboard and pressing END
  488.   will go to the end of the file.
  489.  
  490.  
  491.   5.4  Window Highlighting
  492.   ─────────────────────────────────────────────────────────────────────
  493.   AUTOREAD Version 2 works with several kinds of windows.  The Document
  494.   Window, the Chapter Window, the Keyword Window, and the Bookmark
  495.   Window.  All of these windows can be open (or visible) at the same
  496.   time, and each allows you to use the keyboard to scroll through their
  497.   contents, or take some action on the current item.  So how does the
  498.   program know which window you want to scroll, or to action?
  499.  
  500.   The answer is that keystrokes always go to the currently highlighted
  501.   window.  You can tell which is highlighted by the bright colour of its
  502.   border.  You will often need to change which window is highlighted in
  503.  
  504.                                                    Autoread Manual   -8-
  505.  
  506.   order to make use of it.  You can highlight a visible window (or make
  507.   a hidden window visible and highlighted) in two different ways:
  508.  
  509.   *    By clicking on it with the mouse (if it is visible);
  510.   *    By pressing the "hot key" associated with the "View" choice for
  511.        that window, eg pressing F2 will make the Chapter window visible and
  512.        highlighted, pressing Home will make the Document Window highlighted.
  513.   *    By selecting "View" from the appropriate menu.
  514.  
  515.                                                    Autoread Manual   -9-
  516.  
  517.   6.  A Brief Tour of the AUTOREAD Menu Bar
  518.   ════════════════════════════════════════
  519.  
  520.   This chapter just gives you a quick overview of the choices available.
  521.   Further details of each menu bar choice are given in subsequent
  522.   chapters.
  523.  
  524.   6.1 The = Menu
  525.   ─────────────────────────────────────────────────────────────────────
  526.   This is sometimes called the control menu.  There are only two
  527.   choices, the first "About" calls up copyright information about
  528.   AUTOREAD.  The second is "Help", which brings up a simple help screen.
  529.   (For more detailed help, I suggest closing your current document and
  530.   calling up the AUTOREAD on-line manual - AUTOREAD is its own best help
  531.   system!
  532.  
  533.   6.2  The File Menu
  534.   ─────────────────────────────────────────────────────────────────────
  535.   The File menu lets you open and close documents, and to exit the
  536.   program.  Note that you can close a document either by selecting this
  537.   choice, or by clicking on the close button of the Document Window, or
  538.   by pressing ESC when the Document Window is highlighted.
  539.  
  540.   You may be surprised that there are no "Save" options on this menu.
  541.   That is because you always use AUTOREAD on existing documents, and
  542.   because chapter and keyword information is automatically saved when
  543.   necessary as you close the document.  Note, however, that this means
  544.   that if you have created a lot of new chapter stops you should close
  545.   the document down properly rather than just turning off the computer.
  546.  
  547.  
  548.   6.3  The Document Menu
  549.   ─────────────────────────────────────────────────────────────────────
  550.   The choices on this menu are only active when you have opened a
  551.   document.
  552.  
  553.   Note the first choice - View, with a "hot key" of Home.  You will need
  554.   to select this, or to press Home, in order to highlight the Document
  555.   Window when another window such as the Chapter window is currently
  556.   highlighted.
  557.  
  558.   The Document menu allows you to move quickly to different positions in
  559.   the file: the beginning, the middle, the end, or to a specific line
  560.   number, or to find a particular page number.
  561.  
  562.   There is also a choice on this menu called "Preferences", which lets
  563.   you set certain preferences for how you want AUTOREAD to treat this
  564.   particular document.
  565.  
  566.  
  567.   6.3  The Chapter Menu
  568.   ─────────────────────────────────────────────────────────────────────
  569.   This is perhaps the most powerful part of AUTOREAD.  This menu allows
  570.   you to find instantly any one of potentially thousands of 'chapter
  571.   stops', by selecting a description from a pull-down menu.  They are
  572.   called 'chapter stops' because the idea is that you can set up such
  573.   stops at the beginning of chapters or major sections in the document.
  574.   The number of chapter stops allowed in the shareware version of
  575.  
  576.                                                   Autoread Manual   -10-
  577.  
  578.   AUTOREAD is 400; however if you register, you will be allowed to set
  579.   as many chapter stops as you wish up to the limits of the memory on
  580.   your computer.
  581.  
  582.   This menu allows you to find, create, delete or change an existing
  583.   chapter stop.
  584.  
  585.   It also allows you to clear all existing chapter stops, or to
  586.   automatically make chapter stops at standard points in a document.
  587.  
  588.  
  589.   6.4  The Keywords Menu
  590.   ─────────────────────────────────────────────────────────────────────
  591.   An AUTOREAD keyword is like a FIND command for pre-defined strings.
  592.   It means you can create a list of common or especially important
  593.   words, perhaps from the index of the manual, and quickly point to
  594.   them.  The current version allows you to have up to 250 keywords.
  595.   Once you have chosen a keyword to find, AUTOREAD will quickly scan the
  596.   file looking for the next occurrence of that keyword.
  597.  
  598.   This menu allows you to find, create, or delete keywords.
  599.  
  600.  
  601.   6.5  The Bookmarks Menu
  602.   ─────────────────────────────────────────────────────────────────────
  603.   Bookmarks work in a very similar way to chapter stops, except that
  604.   they are normally temporary (they vanish when you exit AUTOREAD unless
  605.   you've chosen "Save Bookmarks" as part of the document preferences),
  606.   and the listing entries simply give the bookmark number and the first
  607.   text on the line marked.
  608.  
  609.   Bookmarks are intended as a quick way of placing a marker in the text
  610.   while you look for some other information, and then being able to
  611.   quickly return to where you left off.
  612.  
  613.   Note also that if you've chosen "Save Last Session" in the document
  614.   preferences, when you exit AUTOREAD the current position in the file
  615.   when you exited is stored, and when you restart this position is
  616.   automatically set as Bookmark 0, and marked "LAST SESSION" .  If
  617.   you've also chosen "Start At Last Session" in the preferences, the
  618.   document will automatically go to this position when opened.
  619.  
  620.  
  621.   6.6  The Search Menu
  622.   ─────────────────────────────────────────────────────────────────────
  623.   This menu lets you search for any text (not a pre-defined keyword),
  624.   either in the body of the document, or in the Chapter descriptions.
  625.   This latter search is a very quick way to search for a major topic
  626.   which is covered by a chapter heading.
  627.  
  628.  
  629.   6.7  The Utilities Menu
  630.   ─────────────────────────────────────────────────────────────────────
  631.   This menu has several choices which allow you to do various useful
  632.   things: send part of the document to a printer or another file;
  633.  
  634.                                                   Autoread Manual   -11-
  635.  
  636.   specify the location of files that AUTOREAD needs; or change the
  637.   screen mode (the number of lines on the screen).
  638.  
  639.                                                   Autoread Manual   -12-
  640.  
  641.  
  642.   7:  Document Menu
  643.   ═════════════════
  644.  
  645.   The Document Menu looks like this:
  646.                  ┌────────────────┐
  647.                  │ View       Home│
  648.                  │ ---------------│
  649.                  │ Top       ^Home│
  650.                  │ Middle        -│
  651.                  │ End        ^End│
  652.                  │ ---------------│
  653.                  │ Line Number    │
  654.                  │ ---------------│
  655.                  │ Page Number    │
  656.                  │ Odd Page Set   │
  657.                  │ Even Page Set  │
  658.                  │ ---------------│
  659.                  │ Preferences    │
  660.                  └────────────────┘
  661.  
  662.   The Document menu is primarily to give you several ways of moving
  663.   around in the document, and to set document preferences.
  664.  
  665.   7.1  View (Home)
  666.   ─────────────────────────────────────────────────────────────────────
  667.   You need to select this, or to press the Home key, to highlight the
  668.   Document Window, and to bring it to the front (on top of any other
  669.   windows you may have open).  Only when the Document Window is
  670.   highlighted will the rest of the choices on this menu work.
  671.  
  672.   The next four choices on the menu should be self-explanatory:
  673.  
  674.  
  675.   7.2  Top(^Home)
  676.   ─────────────────────────────────────────────────────────────────────
  677.   Goes to the start of the file.
  678.  
  679.  
  680.   7.3  Middle
  681.   ─────────────────────────────────────────────────────────────────────
  682.   Goes to the very middle line of the file.
  683.  
  684.  
  685.   7.4  Bottom (^End)
  686.   ─────────────────────────────────────────────────────────────────────
  687.   Goes to the end of the file.
  688.  
  689.  
  690.   7.5  Line Number
  691.   ─────────────────────────────────────────────────────────────────────
  692.   Lets you enter and go to a particular line number in the document.
  693.  
  694.  
  695.   7.6  Page Number
  696.   ─────────────────────────────────────────────────────────────────────
  697.   This is a very valuable function, allowing you to search for
  698.   particular page numbers in the document.  This is very useful if the
  699.  
  700.                                                   Autoread Manual   -13-
  701.  
  702.   document comes with a contents page and index page which shows these
  703.   page numbers.
  704.  
  705.   Searching for a page number is not as easy as it might sound, however,
  706.   because simply looking for a number such as say 25 will locate many
  707.   erroneous instances of the number which are not page numbers, such as
  708.   in tables, prices, and so on.
  709.  
  710.   So AUTOREAD requires that you set a 'template' for what the page
  711.   numbering looks like in the document.  Fortunately, this is very easy
  712.   to do, and only needs to be done once.  This process is described in
  713.   the following two sub-sections.
  714.  
  715.   Once you have created the template for a particular document, you will
  716.   never need to do it again, as AUTOREAD writes the template(s) to the
  717.   .ARD file.
  718.  
  719.   This may all sound complex.  However, FINDING a page once the template
  720.   is set could not be easier.  Simply choose Page Number from the
  721.   Document Menu, and then enter the desired page.  Note that you can
  722.   enter such constructs as '2-25' with no problems.
  723.  
  724.   AUTOREAD then does a text search for the desired page, checking
  725.   instances of the number against its template.
  726.  
  727.   You will note that the dialog box asks you if you want to start
  728.   searching globally, that is, from the top of the document, or from
  729.   your current position.  The latter will be quicker if you are
  730.   confident the wanted page is further down in the document.
  731.  
  732.   NOTE:
  733.  
  734.   Page find is far from perfect.  Its success will depend on the
  735.   consistency of the way the manual author has set up page numbering.
  736.  
  737.  
  738.   7.7  Odd Page Set
  739.   ─────────────────────────────────────────────────────────────────────
  740.   To set up the page numbering template for odd pages, position the
  741.   document so that a line containing an odd page number is the current
  742.   line (with the < arrow symbol at the very right hand of the screen -
  743.   if you have not set any screen offset in the document preferences,
  744.   this will be the top line of the screen).  E.g., in the Telix manual,
  745.   I positioned a line like this as the current line:
  746.  
  747.                Telix v3.12                   5
  748.  
  749.   When you choose Odd Page Set, you will be shown the current line
  750.   (shorn of any unnecessary spaces at beginning and end, and perhaps
  751.   broken over two lines to fit into the dialog box) and asked what the
  752.   embedded page number is - in the example given it was 5.  With
  753.   numbering of the form 2-5, you should enter this whole construct, i.e.
  754.   2-5, not just 5.  That's all there is to it.
  755.  
  756.   You will see that in the dialog box there is also a check box marked
  757.   "At Bottom of Page", and an input line to enter the page size.  You
  758.   will only need to use these if the document author has placed the page
  759.   numbering at the bottom of the page, rather than the top.  If you
  760.  
  761.                                                   Autoread Manual   -14-
  762.  
  763.   check the box, AUTOREAD will automatically offset the display by the
  764.   page size you have given, so as to bring the top of the wanted page to
  765.   the top of the display.  You may need to experiment with this a little
  766.   to get it right.
  767.  
  768.   NOTE:
  769.  
  770.   If you don't explicitly do an Even Page Set, AUTOREAD assumes that
  771.   even numbered pages are identical to odd numbered pages unless told
  772.   otherwise.  The same applies if you just do an Even Page Set and not
  773.   an Odd Page Set.  You only need to set both if the headers for even
  774.   and odd pages are different.
  775.  
  776.   NOTE:
  777.  
  778.   Avoid positioning on a page whose number is embedded in other text on
  779.   the line, e.g., in the example given above it would have caused
  780.   problems to position on page 3,1,2 or 12, as these numbers are all
  781.   embedded in the 'Telix v3.12' string.
  782.  
  783.  
  784.   7.8  Even Page Set
  785.   ─────────────────────────────────────────────────────────────────────
  786.   This is identical to Odd Page Set, except you should position the
  787.   current line to an EVEN numbered page.  You only need to do this if
  788.   the format for even pages is different from that for odd pages.
  789.  
  790.  
  791.   7.9  Preferences
  792.   ─────────────────────────────────────────────────────────────────────
  793.   This is a very important choice, allowing you to set may different
  794.   choices which affect how AUTOREAD will behave with the current
  795.   document.  The preferences are saved in the .ARD file.
  796.  
  797.   The current preferences you can set are as follows:
  798.  
  799.   7.9.1  Chapter Sort Order
  800.   ─────────────────────────────────────────────────────────────────────
  801.   Normally, AUTOREAD displays chapters in "natural" order, that is, the
  802.   order in which they appear in the document (line order).  However, you
  803.   can change this so that the chapters are listed in alphabetical order
  804.   of their descriptions.  This can be very useful for some kinds of
  805.   application.
  806.  
  807.   NOTE that changing the sort order does not affect the current chapter
  808.   window.  To make the changed order take effect, you must close the
  809.   document and re-open it.  (This is a change from versions prior
  810.   to 2.00, but it has the advantage that AUTOREAD will always use the
  811.   nominated order for this document).   Note also that you will normally
  812.   want to set Show Level Prefixes off (next preference) if you want
  813.   alphabetical order.
  814.  
  815.   7.9.2  Show Level Prefixes and Level Prefix Symbol
  816.   ─────────────────────────────────────────────────────────────────────
  817.   From version 2.00, you can nominate a "level" for chapter stops (see
  818.   next section for more detail).  This allows subsidiary headings to be
  819.   treated differently from major headings, by indenting with a nominated
  820.   symbol.
  821.  
  822.                                                   Autoread Manual   -15-
  823.  
  824.  
  825.   Normally, Show Level Prefixes is on, but you can uncheck this box to
  826.   turn off this effect.  You can also nominate the symbol(s) you want to
  827.   use to mark levels.
  828.  
  829.   7.9.3  Offset Display
  830.   ─────────────────────────────────────────────────────────────────────
  831.   In some applications, it is useful to have AUTOREAD display a few
  832.   lines before the line on which a chapter stop has been set (an example
  833.   would be in long listings of bulletin board messages, where the
  834.   "Subject" line is generally three or four lines below the top of the
  835.   message).  By setting the offset to a value other than zero, you can
  836.   have AUTOREAD behave in this way.  It is not, however, a good idea to
  837.   set this value to anything more than, say, half a screen, or AUTOREAD
  838.   may behave in unexpected ways.
  839.  
  840.   7.9.4  Save Last Session
  841.   ─────────────────────────────────────────────────────────────────────
  842.   If you check this box, AUTOREAD will automatically save the position
  843.   in the document where you were at when you closed the document.  From
  844.   version 2.00, this information is saved in the .ARB file, as Bookmark
  845.   0, described as Last Session.
  846.  
  847.   7.9.5  Start at Last Session
  848.   ─────────────────────────────────────────────────────────────────────
  849.   If you check this box, AUTOREAD will automatically open the Document
  850.   Window at the Last Session (Bookmark 0) point.  This allows you to
  851.   keep reading through a long document through several sessions.  NOTE
  852.   that if you check this box but the Last Session has not previously
  853.   been saved, you will start at the top of the document, as usual.
  854.  
  855.   7.9.6  Save Bookmarks
  856.   ─────────────────────────────────────────────────────────────────────
  857.   I always intended Bookmarks to be simply a temporary version of
  858.   Chapter stops, but after numerous requests from users, Bookmarks are
  859.   now saved in the .ARB file if you choose this option.
  860.  
  861.                                                   Autoread Manual   -16-
  862.  
  863.  
  864.   8:  Chapters Menu
  865.   ═════════════════
  866.  
  867.   The Chapters Menu looks like this:
  868.                    ┌─────────────────┐
  869.                    │ View         F2 │
  870.                    │ Find      Enter │
  871.                    │ Add         Ins │
  872.                    │ Delete      Del │
  873.                    │ Edit    Ctrl-F2 │
  874.                    │ Promote Grey +  │
  875.                    │ Demote  Grey -  │
  876.                    │ --------------  │
  877.                    │ Clear           │
  878.                    │ Make            │
  879.                    └─────────────────┘
  880.  
  881.   As indicated earlier, 'Chapter Stops' are perhaps the most powerful
  882.   part of AUTOREAD.  You can use it to move instantly to the beginning
  883.   of various chapters or sections within the text file.
  884.  
  885.   This menu allows you to find instantly any one of hundreds of 'chapter
  886.   stops', by selecting a description from a pull-down menu.
  887.  
  888.   The Chapters Menu also allows you to add, change and delete such
  889.   chapter stops, as described below:
  890.  
  891.  
  892.   8.1  View (F2)
  893.   ─────────────────────────────────────────────────────────────────────
  894.   You will need to take this choice, or press the "hot key" to make the
  895.   Chapter Window visible and highlighted, and to make the following
  896.   choices work.
  897.  
  898.   Note that the Chapter Window can be resized and repositioned anywhere
  899.   you like, and that it stays visible until you close it, or until you
  900.   select the Document Window (which comes to the front and may obscure
  901.   the Chapter Window.  You can page up and down through the Chapter
  902.   Window the same way as you can with the Document Window.  Note also
  903.   that the Chapter Window stays scrolled to the same spot where you left
  904.   it last.
  905.  
  906.   8.2  Find(Enter)
  907.   ─────────────────────────────────────────────────────────────────────
  908.   Once you have selected your desired chapter stop, press ENTER, or
  909.   double-click on it with the mouse, and the Document Window will
  910.   immediately scroll to the text starting at the desired chapter stop.
  911.   The Document Window will be selected so you can see the text of the
  912.   document.  If you want to choose another chapter, press F2 again:
  913.   the Chapter Window will still be scrolled to the place you were at
  914.   before.
  915.  
  916.  
  917.   8.3  Add Current Line (Ins or Alt-A)
  918.   ─────────────────────────────────────────────────────────────────────
  919.   This allows you to set the current line (that is, the line currently
  920.   at the top of the display screen) as a chapter stop.  If you make this
  921.   choice from the Chapters menu, you will be prompted for a description.
  922.  
  923.                                                   Autoread Manual   -17-
  924.  
  925.   However if you use the Alt-A key when the Document Window is
  926.   highlighted, there are no prompts - the computer will make a warbling
  927.   sound to show that it has captured the current line.
  928.  
  929.   Note that as part of the dialog box, you can set a "level" for the
  930.   current chapter stop.  Higher level numbers indicate more and more
  931.   subsidiary chapters, which are indented to the right in the Chapter
  932.   Window, allowing you to naturally reflect the structure of the
  933.   document with its major headings and sub-headings.  Future versions
  934.   of AUTOREAD may allow you to supress display of lower level headings.
  935.  
  936.  
  937.   8.4  Delete
  938.   ─────────────────────────────────────────────────────────────────────
  939.   This will allow you to get rid of a particular chapter stop.  You'll
  940.   probably use this a good deal after carrying out a Chapter Make
  941.   function.
  942.  
  943.  
  944.   8.5  Edit
  945.   ─────────────────────────────────────────────────────────────────────
  946.   This will allow you to edit the description of a particular chapter
  947.   stop.
  948.  
  949.  
  950.   8.6  Promote & Demote
  951.   ─────────────────────────────────────────────────────────────────────
  952.   These options allow you to easily change the level of a chapter stop.
  953.   Promote (the + key on the numeric keypad) reduces the level number by
  954.   one (lower levels meaning higher priority).  Demote (the - key on the
  955.   numeric keypad) increases the level number and indents the chapter
  956.   description accordingly.
  957.  
  958.  
  959.   8.7  Clear
  960.   ─────────────────────────────────────────────────────────────────────
  961.   This allows you to get rid of ALL current chapter stops.  Please use
  962.   this carefully!
  963.  
  964.   You will be prompted to confirm the clear.
  965.  
  966.  
  967.   8.8  Make
  968.   ─────────────────────────────────────────────────────────────────────
  969.   This is an extremely powerful utility, which allows you to
  970.   automatically create chapter stops from various kinds of clue in the
  971.   text of the document.
  972.  
  973.   If you choose Make, you are taken to a sub-menu, which looks like
  974.   this:
  975.                ┌────────────┐
  976.                │ Textual    │
  977.                │ Procedural │
  978.                │ UpperCase  │
  979.                └────────────┘
  980.  
  981.   These options are each described in the following sections.
  982.  
  983.  
  984.   Note: you can run any form of Make repeatedly on a file to identify
  985.   different levels of sections.  However, in this version of AUTOREAD,
  986.   the software will not let you add two identical chapter stops - the
  987.   second will just never be added.  "Identical" depends on whether you
  988.   have the chapter sort order set to Line or Alpha.  If it is Line, you
  989.   can't set two chapter stops which jump to the same line.  If it is
  990.   Alpha, you can't set two chapter stops with identical descriptions.
  991.   For this reason, there is no need in this version for the "Remove"
  992.   option in earlier versions which eliminated such duplicates.
  993.  
  994.                                                   Autoread Manual   -18-
  995.  
  996.   8.9  Textual Make
  997.   ─────────────────────────────────────────────────────────────────────
  998.   Textual make is the most secure form of the Make command, but will
  999.   only work for documents where the document author has used a standard
  1000.   way of identifying chapter or section beginnings.
  1001.  
  1002.   Textual Make allows you to scan the whole document, looking for a
  1003.   designated string of text, and setting a chapter stop once it has
  1004.   found it.  It is possible to set a line offset from the searched for
  1005.   text, and to specify which "level" the chapter stop should be at.
  1006.  
  1007.   An example will make this easy to understand.
  1008.  
  1009.  
  1010.   8.9.1  A Textual Make Example
  1011.   ─────────────────────────────────────────────────────────────────────
  1012.   One of the first documents I used AUTOREAD on myself was the manual
  1013.   for the excellent shareware text editor QEDIT.  This manual is some
  1014.   5500 lines long.
  1015.  
  1016.   The document author had used a line of equal signs '====' to underline
  1017.   each chapter heading, and a graphic line '_____' to underline each
  1018.   section heading.
  1019.  
  1020.   I first made a pass with Textual Make, searching for the line of equal
  1021.   signs.  Once I selected Textual Make, I was prompted for the text
  1022.   string to search for.  I entered four equal signs, =====.
  1023.  
  1024.   I entered a line offset of 1, and specified that the chapter
  1025.   description was ABOVE the found text, that is, immediately above the
  1026.   underlining found.  If I had wanted the line of equal signs itself to
  1027.   be the chapter stop, I would have entered a line offset of 0.
  1028.  
  1029.   I also specified that these chapter stops should have the highest
  1030.   level of significance, and so set Level to 1.
  1031.  
  1032.   The program then took about 30 seconds to scan through the whole QEDIT
  1033.   document and set up the chapter stops.  AUTOREAD took the first text on
  1034.   the line I indicated I wanted the chapter stop on, and used this as
  1035.   its description for that chapter stop.
  1036.  
  1037.   I then wanted to set up sections as chapter stops, so I carried out
  1038.   another pass with Textual Make.
  1039.  
  1040.   Once I selected Textual Make, I was prompted for the text string to
  1041.   search for.  I entered four graphic line characters, '____'.  (I used
  1042.   the ALT key and the numeric keyboard to enter these characters - refer
  1043.   to your DOS manual if you don't know how to do this).
  1044.  
  1045.   Again the wanted line was the one above the graphic line, I entered an
  1046.   offset of 1, and clicked on ABOVE.
  1047.  
  1048.   This time I set the Level to 2, to make these chapters subsidiary
  1049.   headings.
  1050.  
  1051.                                                   Autoread Manual   -19-
  1052.  
  1053.   Another 30-40 seconds, and I had essentially the equivalent of the
  1054.   contents page of the manual in the form of a pull-down menu.
  1055.  
  1056.   Here is part of the chapter stops menu I created for QEDIT.DOC:
  1057.               ┌──────────────────────────────────────────┐
  1058.               │ - COLORS                                 │
  1059.               │ - TABLE OF CONTENTS                      │
  1060.               │ - ACKNOWLEDGEMENTS                       │
  1061.               │ - INTRODUCTION                           │
  1062.               │ - FEATURES                               │
  1063.               │ - SYSTEM REQUIREMENTS                    │
  1064.               │ - INSTALLATION                           │
  1065.               │ CHAPTER 1. USERS GUIDE FOR QEDIT         │
  1066.               │ - QUICK START                            │
  1067.               │ - MENUS                                  │
  1068.               │ - THE STATUS LINE                        │
  1069.               │ - FILES                                  │
  1070.               │ - VIEWING AND GETTING AROUND IN THE TEX  │
  1071.               │ - CURSOR MOVEMENT                        │
  1072.               │ - USING WINDOWS                          │
  1073.               └──────────────────────────────────────────┘
  1074.  
  1075.   If you are using AUTOREAD on a document you are editing, then I
  1076.   recommend the use of the stand-alone Make utility, described below.
  1077.  
  1078.   Note that the means of designating chapter stops need not be types of
  1079.   underline, as in the example above, but could be the word CHAPTER in
  1080.   capitals (Note that Make distinguishes between upper and lower case,
  1081.   unlike Find Text and Find Keyword), or a special character or series
  1082.   of characters (e.g.  ---> ).
  1083.  
  1084.   The best way to learn how Make works is to try it out.  Don't worry
  1085.   about making mistakes, you can always Clear and start again.
  1086.  
  1087.  
  1088.   8.10  Procedural Make
  1089.   ─────────────────────────────────────────────────────────────────────
  1090.   I added this function after I had been using AUTOREAD myself on quite
  1091.   a number of different shareware manuals.  While the textual make
  1092.   function works very well for manuals where the author has used some
  1093.   standard form of underlining or text identifying the start of chapters
  1094.   and sections, it proves awkward for instances where the author has
  1095.   only used section numbering of the 'procedural' form, i.e.:
  1096.  
  1097. │      1.  INTRODUCTION
  1098. │      1.1 Hello
  1099. │      1.2 Goodbye
  1100. │        1.2.1 Farewell
  1101. │        1.2.2 Cheerio.
  1102.  
  1103.   So I added this function.  The dialog box for Procedural Make will let
  1104.   you specify whether the section numbering is numeric or alphabetic
  1105.   (some authors have appendixes sectioned off in the form:A.1, A.2, B.1,
  1106.   etc).  You can also specify what the separation character should be
  1107.   (in most cases this will be a period, which is the default).
  1108.  
  1109.   Once you have made these choices, the program takes over.  If numeric
  1110.   sectioning was chosen, then AUTOREAD will identify as a chapter stop
  1111.  
  1112.                                                   Autoread Manual   -20-
  1113.  
  1114.   any line whose first text was a number, and if that number was
  1115.   followed by a period (or other separator you specified) before any
  1116.   other character.  It will also count the number of periods in the
  1117.   section number, and set the Level for the description appropriately.
  1118.  
  1119.   If alphabetic sectioning was chosen, then AUTOREAD will identify as a
  1120.   chapter stop any line whose first character was an upper-case letter
  1121.   and whose second character was a period (or specified separator).
  1122.  
  1123.  
  1124.   8.11  UpperCase Make
  1125.   ─────────────────────────────────────────────────────────────────────
  1126.   I added this form of Make when I discovered that there were manuals
  1127.   (PKZIP is a good example) where the ONLY indication of a chapter or
  1128.   section heading was that the heading was all in upper case (capitals).
  1129.  
  1130.   UpperCase Make works by checking each line of the document to see if
  1131.   it is all in upper-case.  Because this is such an uncertain means of
  1132.   identifying chapters, the dialog box allows you to set several other
  1133.   conditions relating to whether non-alpha characters are allowed at the
  1134.   beginning or ending of the line, and whether blanks preceding the text
  1135.   are allowed or required (some authors centre their uppercase
  1136.   headings).  Note that if you specify than N blanks MUST be present,
  1137.   this overrides a specification that LESS than N blanks are allowed.
  1138.   Any line meeting all these requirements will be identified
  1139.   as a chapter stop.
  1140.  
  1141.  
  1142.   8.13  Problems with Make
  1143.   ─────────────────────────────────────────────────────────────────────
  1144.   Almost inevitably, with any of the above forms of Make, you will end
  1145.   up with some invalid chapter stops.  You can either use the Delete
  1146.   function from the Chapter menu to remove these, or edit the .ARD
  1147.   directly (see APPENDIX C on page 36).
  1148.  
  1149.   One particular trap with Procedural Make is Contents Pages.
  1150.  
  1151.   AUTOREAD naturally cannot tell the difference from a section heading
  1152.   in the body of the text and that heading repeated in the Contents
  1153.   Page.  If you have a document with a problem contents page, simply
  1154.   position the current line so it is after the contents page, and then
  1155.   when you do the make, select "From Current Line" rather than "From
  1156.   Beginning of Document" in the dialog box.
  1157.  
  1158.   UpperCase Make is very subject to erroneous entries, because all it
  1159.   has to go on is a line which is all in capitals.  However, the
  1160.   additional conditions you can now set in this version allow you to
  1161.   eliminate some false hits, and it is now also much easier to delete
  1162.   erroneous entries as you step through the document.
  1163.  
  1164.  
  1165.   8.13  The Stand-Alone Make Utility
  1166.   ─────────────────────────────────────────────────────────────────────
  1167.   Particularly for the use of those using AUTOREAD as a help system, and
  1168.   for shareware authors who might like to distribute a special version
  1169.   of AUTOREAD with their shareware manuals (see page 30), I have
  1170.   provided a stand-alone chapter make utility, CHAPMAKE.EXE.  This is
  1171.   also useful to anyone using AUTOREAD on a document which for whatever
  1172.   reason has to be altered regularly.
  1173.  
  1174.                                                   Autoread Manual   -21-
  1175.  
  1176.  
  1177.   The advantage of this utility is that it allows you to set up an
  1178.   automated chapter make which you can run each time you have made a
  1179.   significant change to your manual or other document you wish to use
  1180.   AUTOREAD on.
  1181.  
  1182.   To run CHAPMAKE, enter a command line such as the following:
  1183.  
  1184.                 CHAPMAKE MANUAL
  1185.  
  1186.   However, you must first create a text file with the make commands in
  1187.   it.  This file normally has the same name as the document you'll use
  1188.   AUTOREAD on, but with an extent of .MAK.  So if your document is called
  1189.   MANUAL.DOC, then the make file will be called MANUAL.MAK.  Note
  1190.   however that you can optionally use a standard make file by including
  1191.   its name on the command line, e.g.:
  1192.  
  1193.             CHAPMAKE MANUAL STANDARD.MAK
  1194.  
  1195.   This has the advantage of being able to use a single standard make
  1196.   file for several different manuals.
  1197.  
  1198.   The make file can have any number of command lines.  The current
  1199.   commands are described as follows:
  1200.  
  1201.  
  1202.   8.13.1  C - Clear Chapters
  1203.   ─────────────────────────────────────────────────────────────────────
  1204.   A line with the character 'C' at its start will clear all  existing
  1205.   chapter stops, just as if you had selected Clear  from the Chapters
  1206.   Menu.
  1207.  
  1208.   Note that any existing keywords are left untouched.
  1209.  
  1210.  
  1211.   8.13.2  T - Textual Make
  1212.   ─────────────────────────────────────────────────────────────────────
  1213.   A line starting with 'T' has the effect of a Textual Make  command as
  1214.   selected from the Chapters Menu.
  1215.  
  1216.   The 'M' must be followed by the text to search for, the  line offset,
  1217.   and the level, all separated by slashes (/).  These are exactly as you
  1218.   would enter them in the menu-driven  make utility within AUTOREAD.
  1219.  
  1220.   For example, take the following line:
  1221.  
  1222.                T/***/-1/1
  1223.  
  1224.   This line in the make file would set up as chapter stops the lines
  1225.   preceding the text ''***", and would set the level to 1.
  1226.  
  1227.  
  1228.   8.13.3  N - Numeric Procedural Make
  1229.   ─────────────────────────────────────────────────────────────────────
  1230.   A line beginning with 'N' acts exactly as if you had chosen Procedural
  1231.   Make from the Chapters Menu, and then selected Numeric section
  1232.   numbering.  You can follow the 'N' with a slash and a character to
  1233.   indicate the separator if it is anything other than a period.
  1234.  
  1235.                                                   Autoread Manual   -22-
  1236.  
  1237.  
  1238.  
  1239.   8.13.4  A - Alphabetical Procedural Make
  1240.   ─────────────────────────────────────────────────────────────────────
  1241.   A line beginning with 'A' acts exactly as if you had chosen Procedural
  1242.   Make from the Chapters Menu, and then selected Alphabetic section
  1243.   numbering.You can follow the 'A' with a slash and a character to
  1244.   indicate the separator if it is anything other than a period.
  1245.  
  1246.  
  1247.   8.13.5  U - UpperCase Make
  1248.   ─────────────────────────────────────────────────────────────────────
  1249.   A line beginning with 'U' acts exactly as if you had chosen UpperCase
  1250.   Make from the Chapters Menu.
  1251.  
  1252.  
  1253.   8.13.6  Example Make File:
  1254.   ─────────────────────────────────────────────────────────────────────
  1255.   This is the Make file I use for the AUTOREAD manual:
  1256.  
  1257.              C
  1258.              T/ ═════/-1/1
  1259.              N
  1260.  
  1261.   8.13.8  An Important Note!
  1262.   ─────────────────────────────────────────────────────────────────────
  1263.   At present, CHAPMAKE is limited in how much you can control the make
  1264.   process.  This means that you can't specify a starting line for any
  1265.   methods (CHAPMAKE will start searching at the beginning of the
  1266.   document), nor can you specify conditions for the uppercase make type.
  1267.  
  1268.                                                   Autoread Manual   -23-
  1269.  
  1270.  
  1271.  
  1272.   9:  Keywords Menu
  1273.   ═════════════════
  1274.  
  1275.   A keyword is simply a text string to be found in your document, and
  1276.   the Find Keyword function works exactly as does the Find Text
  1277.   function, except that you don't need to type in the required text: you
  1278.   simply select it from a pull-down menu.
  1279.  
  1280.   The Index of a document is a great place to find useful keywords.
  1281.  
  1282.   The Keywords Menu looks like this:
  1283.                 ┌──────────────────┐
  1284.                 │ View        F3   │
  1285.                 │ Find     Enter   │
  1286.                 │ Add        Ins   │
  1287.                 │ Delete     Del   │
  1288.                 │ Edit   Ctrl-F3   │
  1289.                 └──────────────────┘
  1290.  
  1291.   9.1  View (F3)
  1292.   ─────────────────────────────────────────────────────────────────────
  1293.   This brings up a scrolling window of the existing keywords.  You can
  1294.   move the highlight to the wanted keyword by using the up and down
  1295.   arrow keys or the scroll bars.
  1296.  
  1297.   9.2  Find (Enter)
  1298.   ─────────────────────────────────────────────────────────────────────
  1299.   Once you have selected your desired keyword, press ENTER, and the
  1300.   screen will begin searching from the current line for the wanted
  1301.   keyword.  If the keyword cannot be found, an error message will
  1302.   appear.
  1303.  
  1304.   Note that unlike the Chapter Make command, Find Keyword IGNORES the
  1305.   difference between upper and lower case.  That is, 'DOS', 'Dos' and
  1306.   'dos' will all be found by the same keyword choice.
  1307.  
  1308.   Once the keyword is found, the first occurrence of the wanted keyword
  1309.   will be on the top line of the Document Window, and all occurrences of
  1310.   the keyword on the current screen will be highlighted in the current
  1311.   highlight colour.
  1312.  
  1313.  
  1314.   9.3  Add (Ins)
  1315.   ─────────────────────────────────────────────────────────────────────
  1316.   This prompts you for the text of a new keyword, which will be added to
  1317.   the list of existing keywords in alphabetical order.
  1318.  
  1319.  
  1320.   9.4  Delete (Del)
  1321.   ─────────────────────────────────────────────────────────────────────
  1322.   This will allow you to get rid of a particular keyword.
  1323.  
  1324.  
  1325.   9.5  Edit (Ctrl-F3)
  1326.   ─────────────────────────────────────────────────────────────────────
  1327.   This lets you change the highlighted keyword.
  1328.  
  1329.                                                   Autoread Manual   -24-
  1330.  
  1331.  
  1332.  
  1333.   10:  Bookmarks Menu
  1334.   ═══════════════════
  1335.  
  1336.   Bookmarks are just like chapter stops - except that they are volatile
  1337.   (they vanish when you exit AUTOREAD), and that they do not have a
  1338.   description, just an ID number and a line number.
  1339.  
  1340.   Bookmarks are intended as quick reference points to 'hold your place'
  1341.   when you are looking for something else in a file.  You can only
  1342.   create a maximum of 10 bookmarks.
  1343.  
  1344.   The Marks Menu looks like this:
  1345.                ┌─────────────────┐
  1346.                │ View         F4 │
  1347.                │ Find      Enter │
  1348.                │ Add         Ins │
  1349.                │ Delete      Del │
  1350.                │ Edit    Ctrl-F4 │
  1351.                └─────────────────┘
  1352.  
  1353.   10.1  View (F4)
  1354.   ─────────────────────────────────────────────────────────────────────
  1355.   This brings up a scrolling window of the existing bookmarks.  You can
  1356.   move the highlight to the wanted bookmark by using the up and down
  1357.   arrow keys or the scroll bars.
  1358.  
  1359.  
  1360.   10.2  Find (Enter)
  1361.   ─────────────────────────────────────────────────────────────────────
  1362.   Once you have selected your desired bookmark, press ENTER, and the
  1363.   Document Window will immediately fill with the text starting at the
  1364.   desired bookmark.
  1365.  
  1366.  
  1367.   10.3  Add (Ins)
  1368.   ─────────────────────────────────────────────────────────────────────
  1369.   This allows you to set the current line as a bookmark.  Note that, as
  1370.   with Chapter stops, you can alter the text of the description as you
  1371.   wish (eg, you could change it to read "IMPORTANT BIT ON BOOKMARKS").
  1372.  
  1373.   You will be prompted for the bookmark number you wish this line to be
  1374.   recorded against.  You can have up to 9 bookmarks at any one time.
  1375.  
  1376.  
  1377.   10.4 Delete (Del)
  1378.   ─────────────────────────────────────────────────────────────────────
  1379.   This clears the currently highlighted bookmark.
  1380.  
  1381.  
  1382.   10.5 Edit (Ctrl-F4)
  1383.   ─────────────────────────────────────────────────────────────────────
  1384.   This lets you alter the currently highlighted bookmark.
  1385.  
  1386.  
  1387.                                                   Autoread Manual   -25-
  1388.  
  1389.   10.6  Function Key Setting & Finding Marks
  1390.   ─────────────────────────────────────────────────────────────────────
  1391.   Because bookmarks are mainly used for very rapid access to temporary
  1392.   locations in the file, AUTOREAD allows you to completely bypass the
  1393.   menu system in setting and finding bookmarks.
  1394.  
  1395.   While you are in the Document Window and at a point in the text you
  1396.   wish to return to after looking somewhere else, hold down the SHIFT
  1397.   key and one of the function keys F1..F9.  You will hear a warbling
  1398.   sound, indicating that the equivalent bookmark has been set at that
  1399.   point (i.e., pressing Shift F2 sets bookmark 2).
  1400.  
  1401.   After you have browsed elsewhere, you can hold down the ALT key and
  1402.   the function key (F1...F9) corresponding to the bookmark you set
  1403.   previously.  You will immediately jump back to the place you left.
  1404.  
  1405.   Note that you can use ALT and the function keys to jump to ANY
  1406.   bookmark, whether set with SHIFT + function key or set through the
  1407.   Bookmarks menu.
  1408.  
  1409.  
  1410.   NOTE:  If you have selected Save Last Session in the document
  1411.   preferences, AUTOREAD will automatically make bookmark 0 correspond to
  1412.   the last position you were reading when you closed the document last
  1413.   time.  ALT-F10 will take you to this bookmark immediately, or you can
  1414.   just select it from the Bookmarks Window.
  1415.  
  1416.                                                   Autoread Manual   -26-
  1417.  
  1418.  
  1419.   11:  Find Menu
  1420.   ══════════════
  1421.  
  1422.   The Find Menu looks like this:
  1423.              ┌────────────────────────────┐
  1424.              │ Find Text               F5 │
  1425.              │ Last Find:              F6 │
  1426.              │ -------------------------- │
  1427.              │ Find In Chapter:   Ctrl-F5 │
  1428.              │ Last Chapter Find: Ctrl-F6 │
  1429.              └────────────────────────────┘
  1430.  
  1431.   11.1  Find Text (F5)
  1432.   ─────────────────────────────────────────────────────────────────────
  1433.   This will prompt you for the text to be found.  You can specify
  1434.   whether you wish the match to ignore upper and lower case
  1435.   distinctions, and the direction of the search.
  1436.  
  1437.   Once you have entered your desired text, press ENTER or click on the
  1438.   OK button, and the screen will begin searching in the indicated
  1439.   direction for the wanted text.  If the text cannot be found, an error
  1440.   message will appear.
  1441.  
  1442.   Once the wanted text is found, the first occurrence of the wanted text
  1443.   will be shown on the top line of the Document Window, and all
  1444.   occurrences of the wanted text on the current screen will be
  1445.   highlighted in the current highlight colour.
  1446.  
  1447.  
  1448.   11.2  Last Find (F6)
  1449.   ─────────────────────────────────────────────────────────────────────
  1450.   This retains a memory of the last text string you looked for, and
  1451.   enables you to select it again.  Otherwise, it works exactly like the
  1452.   Find Text command.
  1453.  
  1454.   Note that finding a keyword is treated as a find-text command, so that
  1455.   Last Find can be used to repeatedly find the same keyword.
  1456.  
  1457.  
  1458.   11.3  Find In Chapter (Ctrl-F5)
  1459.   ─────────────────────────────────────────────────────────────────────
  1460.   This allows you to search for a text string in the Chapter Stop list.
  1461.   This can be a very quick way to find a topic in a large document,
  1462.   which has hundreds of chapter stops.
  1463.  
  1464.   Find In Chapter searches ONLY the chapter stop descriptions.  Otherwise,
  1465.   it works exactly like find text.
  1466.  
  1467.  
  1468.   11.4  Last Chapter Find (Ctrl-F6)
  1469.   ─────────────────────────────────────────────────────────────────────
  1470.   This just searches again in the chapter descriptions from the current
  1471.   point for the same text as your last chapter search.
  1472.  
  1473.                                                   Autoread Manual   -27-
  1474.  
  1475.   12.:  Utilities Menu
  1476.   ════════════════════
  1477.  
  1478.   The Utilities Menu looks like this:
  1479.               ┌─────────────┐
  1480.               │ Screen Mode │
  1481.               │ Directories │
  1482.               │ Output Text │
  1483.               └─────────────┘
  1484.  
  1485.   12.1  Screen Mode
  1486.   ─────────────────────────────────────────────────────────────────────
  1487.   This brings up a dialog box which lets you alter the number of lines
  1488.   you can see on your screen (provided your video card and monitor
  1489.   support this).  Using AUTOREAD with more than 25 lines on the screen
  1490.   is often the best (if you have good eyesight), because you can see
  1491.   quite a bit of the document text while keeping the Chapter Window
  1492.   visible and handy.
  1493.  
  1494.   12.2  Directories
  1495.   ─────────────────────────────────────────────────────────────────────
  1496.   The ONLY time you will need to use this option is if you have a
  1497.   particular wish or need to place the AUTOREAD-created files in a
  1498.   directory other than the one that the document you are reading is in.
  1499.   Why might you need to do this?  Well, the source document might be on
  1500.   a write-protected disk, for example, and using the AUTOREAD defaults
  1501.   would cause trouble, because the program wouldn't be able to create an
  1502.   index file on that disk.  A classic example would be a document on a
  1503.   CD-ROM, which is by definition write-protected.
  1504.  
  1505.   Or you might be on a network, where the source document and its index
  1506.   are on a server, but you want to keep your own personal bookmarks file
  1507.   in your personal directory.
  1508.  
  1509.   Altering the default directories gives you a lot more flexibility.
  1510.  
  1511.   Note, however, that you must alter the directories BEFORE you open the
  1512.   source document.  You can also do this on the command line (see page
  1513.   35), allowing you to open a document on the command line with the
  1514.   directories set as you wish them.
  1515.  
  1516.  
  1517.   12.3  Output Text
  1518.   ─────────────────────────────────────────────────────────────────────
  1519.   This choice allows you to copy ('dump') parts of the document you are
  1520.   reading either to another file, or to the printer.
  1521.  
  1522.   The choices shown in the dialog box for this choice relate to what
  1523.   parts of the document you wish to be dumped, and whether you wish to
  1524.   dump to a file or a printer.  In the case of a file, you must enter a
  1525.   file name.  If the file already exists, you will be asked if you wish
  1526.   to append to the end of the file, or to overwrite the existing file
  1527.   (i.e., destroy it and start again).
  1528.  
  1529.   The following describe the action of the various dump dialog box
  1530.   options for the scope of the material to be dumped.
  1531.  
  1532.  
  1533.                                                   Autoread Manual   -28-
  1534.   12.3.1  Screen
  1535.   ─────────────────────────────────────────────────────────────────────
  1536.   Choosing this will dump just what you can see on the display screen at
  1537.   the current time, less the top and bottom status lines.
  1538.  
  1539.  
  1540.   12.3.2  Chapter
  1541.   ─────────────────────────────────────────────────────────────────────
  1542.   This will dump the entire current chapter or section.  AUTOREAD will
  1543.   determine the 'current chapter' as the material between the chapter
  1544.   stop prior to the current line number, up to the line before the
  1545.   chapter stop following the current line number.  If you position a
  1546.   chapter stop heading as the current line, then dump, you will dump
  1547.   from that heading to just before the next chapter stop heading.
  1548.  
  1549.  
  1550.   12.3.3  Lines
  1551.   ─────────────────────────────────────────────────────────────────────
  1552.   This lets you enter your own start and ending line for the dump.
  1553.   Entering '1' for the first line, and some number larger than the last
  1554.   line in the file will dump the entire document.
  1555.  
  1556.  
  1557.   12.3.4  Page Break
  1558.   ─────────────────────────────────────────────────────────────────────
  1559.   This simply lets you send a form feed to the printer, or to embed a
  1560.   form-feed character (^L) in the file.
  1561.  
  1562.                                                   Autoread Manual   -29-
  1563.  
  1564.  
  1565.   13:  The Read-Only Version
  1566.   ══════════════════════════
  1567.  
  1568.   For companies wishing to use AUTOREAD to set up on-line help systems,
  1569.   shareware authors, and others wanting to distribute a version of
  1570.   AUTOREAD with manuals, there is a special "read-only" version of
  1571.   AUTOREAD (called READAUTO) which omits some features (such as Make),
  1572.   which are of use only to users wanting to use AUTOREAD on any
  1573.   document, and prevents users from making changes to your chapter stops
  1574.   and keywords.  Please contact me about a license fee which will allow
  1575.   you to distribute as many copies of the special version with your own
  1576.   manuals as you require.
  1577.  
  1578.   You will find it very easy to set up the customised version of
  1579.   AUTOREAD to work with your manual, establishing chapter stops and
  1580.   appropriate keywords, so that your users will find your on-disk manual
  1581.   a truly easy-to-use and valuable reference.
  1582.  
  1583.                                                   Autoread Manual   -30-
  1584.  
  1585.  
  1586.   14:  Acknowledgements
  1587.   ═════════════════════
  1588.  
  1589.   AUTOREAD was written using Borland's Turbo Pascal (Versions 5.5
  1590.   and 6.0), a great compiler which goes on getting better and better,
  1591.   especially with the Turbo Vision interface I have used in version 2.0.
  1592.  
  1593.   I used QEDIT Advanced 2.08 from SEMWARE as my text editor during
  1594.   programming and for early versions of this manual.  I've also
  1595.   mentioned QEDIT in a number of places in this manual, to illustrate
  1596.   how AUTOREAD can be used to make access to a large text file manual
  1597.   easy, and I hope SEMWARE didn't mind me doing so!
  1598.  
  1599.   QEDIT is still terrific, but SEMWARE have just developed an even better
  1600.   editor called The Semware Editor (TSE), which is phenomenal!  For these
  1601.   products, I recommend you write to SEMWARE at Suite C3A,
  1602.   4343 Shallowford Rd, Marietta, GA 30062-5022 USA for their current prices.
  1603.  
  1604.   The printed version of this manual was produced with Microsoft Word
  1605.   for Windows, on a Hewlett-Packard DeskJet 500, both terrific products.
  1606.  
  1607.   Thanks to Don Avila, Russell Herman, Jerrold Maxwell, Terry Allen,
  1608.   Rick Foster, Ralph Bednarski and many others for reporting bugs and
  1609.   suggesting improvements to AUTOREAD.
  1610.  
  1611.                                                   Autoread Manual   -31-
  1612.  
  1613.  
  1614.   15:  Version History
  1615.   ════════════════════
  1616.  
  1617.   This is version 2.00 of AUTOREAD, and it is a total re-write from
  1618.   versions 1.00 thru 1.10.  There may still be a few bugs in it.  I
  1619.   would be grateful if those who find such bugs could let me know.
  1620.   Similarly, if you have any ideas for ways of improving the product,
  1621.   please let me know.  In particular, there are some features of
  1622.   AUTOREAD version 1.10 that I have had to leave out of version 2.00
  1623.   because of the different way things are handled under the Turbo Vision
  1624.   interface (and to prevent the program size blowing out even more!).  I
  1625.   really need to know how important these missing features are to you.
  1626.   If they are vital, I will make every effort to re-instate them.
  1627.  
  1628.  
  1629.   15.1  Updates
  1630.   ─────────────────────────────────────────────────────────────────────
  1631. │ 1.01 : (2 July 1990)
  1632. │  - GLOBAL search direction added
  1633. │  - fix to bug allowing line 0 to be displayed in status
  1634. │  - fix to bug involving embedded '/' char in chapter description
  1635. │ 1.02 : (5 July 1990)
  1636. │  - added highlighting of keywords and found text
  1637. │  - changed index file extent from .IDX to .ARI
  1638. │ 1.03 : (6 July 1990)
  1639. │ - added procedural make.
  1640. │ - support for 43-line and 50-line screens.
  1641. │ - added alpha sort for chapters
  1642. │ - added stand-alone make utility
  1643. │ 1.04 : (14 July 1990)
  1644. │ - added F1 function key for Help
  1645. │ - added F5 function key for Last Find
  1646. │ - added F6 function key for Jump to Next Chapter Stop
  1647. │ - fixed Upper/Lower case problem with highlighting
  1648. │ - fixed bug with files of longer than 32k lines
  1649. │ - added Crawl Read
  1650. │ 1.05 : (23 July 1990)
  1651. │ - added UpperCase make and set up Make sub-menu
  1652. │ - increased maximum chapter stops to 500
  1653. │ 1.06 : (1 August 1990)
  1654. │ - added F7 function for instant Add Chapter
  1655. │ - added Page Find function
  1656. │ 1.07 : (6 August 1990)
  1657. │ - added Dump function
  1658. │ - added F5 for Find Text, rearranged other function keys
  1659. │ 1.08 : (20 September 1990)
  1660. │ - fixed bug preventing last line of file being seen
  1661. │ - added saving of screen colours to .ARD file
  1662. │ - added screen offset feature
  1663. │ - improved indexing procedure
  1664.                                                   Autoread Manual   -32-
  1665.  
  1666. │ - added Alt-Q - Quit Without Data Save
  1667. │ - added Remove Duplicates to Chapter Menu
  1668. │ 1.09 : (28 March 1991)
  1669. │ - changed file indexing procedure, to fix errors some users getting
  1670. │ with old method.
  1671. │ 1.10 : (19 October 1991)
  1672. │ - added file buffering
  1673. │ - added In Chapter Find (find text in chapter heading)
  1674. │ - added -F find text command-line option
  1675. │ - altered format of .ARD file
  1676. │ - added New Page option to Dump menu
  1677. │ - altered Bookmark display (now includes first text on marked lines)
  1678. │ - altered Last Session handling (now places bookmark instead of
  1679. │ immediate jump)
  1680. │ 2.00 : (11 December 1992)
  1681. │ - Complete rewrite
  1682. │ - Much better user interface: mouse control, scroll bars, standard
  1683. │   menu behaviour.  Menu options always visible.
  1684. │ - Chapter, Keywords and Bookmarks windows moveable and resizable.
  1685. │   Also now retain their current scrolled position.
  1686. │ - Dialog boxes now offer greater choice without having to ask a series
  1687. │   of tedious questions.
  1688. │ - Much larger documents can be accessed - anticipated (but not tested)
  1689. │   to be able to handle files of in excess of 2 million lines.  (Note
  1690. │   that only the registered version has this capability)
  1691. │ - No limits (in registered version) to number of chapter stops or
  1692. │   keywords, within available memory.
  1693. │ - Chapter descriptions no longer limited to 40 characters wide.
  1694. │ - Easy alteration to 43/50 screen line display through Utilities.
  1695. │ - Bookmarks can now optionally be saved.
  1696. │ - Behaviour of Autoread for a particular document can be altered
  1697. │   through Preferences.
  1698. │ - Now keeps track of whether .ARD file needs to be re-saved.
  1699. │ - Index (.ARI), Data (.ARD) and Bookmarks (.ARB) files can optionally
  1700. │   reside in a different directory to the document file.   This allows
  1701. │   AUTOREAD to be used on documents residing on read-only or write-
  1702. │   protected disks (for example, with text documents residing on CD-ROM).
  1703. │ - AUTOREAD can be left running while documents are closed and opened.
  1704. │ - Document selection through standard dialog box.
  1705. │ 2.01 : (10 May 1993)
  1706. │ - A number of bugs in 2.00 fixed.
  1707. │ - Promote and Demote levels added
  1708. │ - Changed behaviour of Chapter, Keyword and Bookmarks windows after a
  1709. │   find entry (document window now automatically selected).
  1710. │ DRAWBACKS/OMISSIONS in Version 2.0x:
  1711. │ - Screen colours no longer selectable (this will be provided in future
  1712. │   versions).
  1713. │ - "Crawl Read" not currently supported.
  1714. │ - Executable file is now much bigger ~160k rather than ~60k.
  1715.  
  1716.                                                   Autoread Manual   -33-
  1717.  
  1718.  
  1719.   APPENDIX A: FUNCTION KEY SUMMARY
  1720.   ════════════════════════════════
  1721.  
  1722.       F1: Help
  1723.       F2: View Chapter List
  1724.       F3: View Keyword List
  1725.       F4: View Bookmark List
  1726.       F5: Text Find
  1727.       F6: Repeat Last Keyword or Text Find
  1728.       F8: Jump to Next Chapter Heading
  1729.    Ctrl-F5: Find Text in Chapter Heading
  1730.    Ctrl-F6: Repeat Chapter Find
  1731.  
  1732.    Alt-A: Add current line as Chapter
  1733.    Alt-X: Quit Autoread
  1734.    ESC:   Close Current Window
  1735.  
  1736.    Shift-F1
  1737.     Thru    : Set Corresponding Bookmark
  1738.    Shift-F9
  1739.  
  1740.    Alt-F1
  1741.     Thru   : Jump to Corresponding Bookmark
  1742.    Alt-F9
  1743.  
  1744.                                                   Autoread Manual   -34-
  1745.  
  1746.  
  1747.  
  1748.   APPENDIX B: COMMAND-LINE OPTIONS
  1749.   ════════════════════════════════
  1750.  
  1751.   To use a command-line option, append the desired option (which must
  1752.   begin with a hyphen) to the command line you use to start up AUTOREAD,
  1753.   eg:
  1754.  
  1755.        AUTOREAD MANUAL.DOC -X -Y
  1756.  
  1757.   Note that you cannot use command-line options UNLESS you are starting
  1758.   up a document on the command line.  That is, a line like:
  1759.  
  1760.        AUTOREAD -X -Y
  1761.  
  1762.   ...will simply ignore the command line options.
  1763.  
  1764.   The current command-line options are described below.
  1765.  
  1766.   -F"Search Text":
  1767.        This allows you to start AUTOREAD and immediately carry out a
  1768.   search for some topic.  Note that the text should be in quotes if it
  1769.   includes a space.  Note also that this option starts by searching the
  1770.   Chapter list for the topic, and if found, it will  go straight to that
  1771.   chapter stop.  If the topic text cannot be found in the chapter
  1772.   descriptions, AUTOREAD will start to  search the whole text of the
  1773.   document.  This facility is very useful for setting up "Help" systems.
  1774.  
  1775.   -Idirectory
  1776.   -Ddirectory
  1777.   -Bdirectory
  1778.        These options let you specify the directories where AUTOREAD will
  1779.   look for the document Index (.ARI), Data (.ARD) and Bookmark (.ARB)
  1780.   files respectively.  The default in each case is the same directory as
  1781.   the source document.
  1782.  
  1783.                                                   Autoread Manual   -35-
  1784.  
  1785.  
  1786.  
  1787.   APPENDIX C: THE .ARD FILE FORMAT
  1788.   ════════════════════════════════
  1789.  
  1790.   It's often worthwhile using a text editor directly on the .ARD file in
  1791.   order to tidy things up, quickly remove invalid chapter stops which
  1792.   were created by Make, and so on.  You can also capture the index pages
  1793.   of the original document and massage them into a list of keywords,
  1794.   which you can directly append to the .ARD file.
  1795.  
  1796.   The .ARD file is just an ordinary text file.
  1797.  
  1798.   The following applies to Version 2.00 of the software.  There have
  1799.   been some changes since version 1.10, but AUTOREAD will still read
  1800.   version 1.10 .ARD files.  It will not, however, read .ARD files from
  1801.   earlier versions.  However, it is a simple matter to convert these
  1802.   earlier .ARD files to the new format.
  1803.  
  1804.   The file is marked off into sections, each with a header of the form:
  1805.   #[section name].  These headers are then followed by lines of data.
  1806.   Here is a sample .ARD file:
  1807.  
  1808.   #[SCREEN]
  1809.   0/0/0/0
  1810.  
  1811.   #[PAGE NUMBERS]
  1812.   Gryll Grange Page -/50
  1813.   Page -/0
  1814.   0
  1815.  
  1816.   #[PREFERENCES]
  1817.   L/0/N/N/Y/Y/-/
  1818.  
  1819.   #[MISCDONE]
  1820.  
  1821.   #[CHAPTERS]
  1822.   Prologue/211/1
  1823.   Chapter One/425/1
  1824.   Intermezzo/534/2
  1825.   Chapter Two/678/1
  1826.   Epilogue/1009/1
  1827.  
  1828.   #[KEYWORDS]
  1829.   bravery
  1830.   lust
  1831.   passion
  1832.   romance
  1833.   woe
  1834.  
  1835.  
  1836.   Let's look at each section in turn.
  1837.  
  1838.   The #[SCREEN] section is currently unused, but in future versions of
  1839.   AUTOREAD will be used to store screen colours and possibly some other
  1840.   information.
  1841.  
  1842.   The #[PAGE NUMBERS] section is of the following form:
  1843.  
  1844.                                                   Autoread Manual   -36-
  1845.  
  1846.  
  1847.   MyManual p./69
  1848.   MyManual/12
  1849.   0
  1850.  
  1851.   where the text before the slash is the text that AUTOREAD uses to
  1852.   check that it has found a page numbering line, and the number after
  1853.   the slash is the column number near where AUTOREAD will check for the
  1854.   wanted page number in the page numbering line. If no page templates have
  1855.   been set, then these numbers will be -1 for both odd and even pages.
  1856.  
  1857.   The third line in this section indicates the page size, if the page
  1858.   numbering has been indicated to be at the bottom of the page.
  1859.  
  1860.   The next section, #[PREFERENCES] of course stores the preferences you
  1861.   have selected for the document, in the following order:
  1862.  
  1863.   Item 1: L or A:  Indicates Line or Alpha sort order
  1864.   Item 2: Screen offset - an integer
  1865.   Item 3: Save Last Session - Y or N
  1866.   Item 4: Start At Last Session - Y or N
  1867.   Item 5: Save Bookmarks - Y or N
  1868.   Item 6: Show Level Prefixes - Y or N
  1869.   Item 7: Level Prefix characters - ASCII text.
  1870.  
  1871.   #[MISCDONE] simply speeds up processing by telling AUTOREAD that this
  1872.   is the end of its miscellaneous information before it hits the
  1873.   Chapters and Keywords.  You can cut it out without any problems, but
  1874.   it may slightly slow down document loading.
  1875.  
  1876.   #[CHAPTERS] is of course the header for the list of chapter stops, all
  1877.   of which are in the following format:
  1878.  
  1879. │          1.0 INTRODUCTION/25/1
  1880.  
  1881.   The text is of course the chapter description text, and
  1882.   the first number following the slash is the line number where the
  1883.   chapter begins.  The second number is the level of the chapter.
  1884.  
  1885.   The #[KEYWORDS] section is of course the list of keywords, in
  1886.   alphabetical order.
  1887.  
  1888.   If you want to manipulate the .ARD file, feel free to do so.   It is
  1889.   easy to simply delete or add keywords, or to delete erroneous chapter
  1890.   stops.  Note however that you will need to know the line number if you
  1891.   wish to add chapter stops.  The sections in the .ARD file should be in
  1892.   the order shown; in particular, the KEYWORDS section must follow the
  1893.   CHAPTERS section.
  1894.  
  1895.                                                   Autoread Manual   -37-
  1896.  
  1897.  
  1898.  
  1899.   APPENDIX D: LIMITATIONS OF AUTOREAD
  1900.   ═══════════════════════════════════
  1901.  
  1902.   AUTOREAD, like most things, is not perfect.  It has limitations.
  1903.   However, version 2.00 lifts a lot of the previous limitations on size
  1904.   - provided you register your copy!
  1905.  
  1906.   Version 2.00 (registered) allows the handling of files up to 2,100,000
  1907.   lines in length.  A typical text file with this many lines would be
  1908.   around 80MB in size!!  The unregistered version lets you handle files
  1909.   of only up to 30,000 lines.
  1910.  
  1911.   There are no limitations on the number of chapter stops or keywords in
  1912.   the registered version, other than those due to memory limitations.
  1913.   On a 640K machine, you should be able to set thousands of chapter
  1914.   stops with no problems.  Again, however, the unregistered version sets
  1915.   limits - 400 chapter stops and 100 keywords.  What a good reason to
  1916.   register!
  1917.  
  1918.   AUTOREAD also has no way of determining if a file you are trying to
  1919.   use it on is in fact a text file.  It will do very weird things if you
  1920.   use it on a binary file such as an .EXE file, for example.  If you
  1921.   need to examine binary files, use the Norton Utilities or LIST.
  1922.  
  1923.   AUTOREAD will also get very confused if you feed it files with very
  1924.   long lines.  AUTOREAD can at least handle without confusion files
  1925.   which include lines of up to 255 characters.  Any more than that, and
  1926.   AUTOREAD loses track of the beginnings of lines.
  1927.  
  1928.                                                   Autoread Manual   -38-
  1929.  
  1930.  
  1931.   APPENDIX E: MUSINGS ON THE WRITING OF MANUALS
  1932.   ═════════════════════════════════════════════
  1933.  
  1934.   I guess I was naive when I first set out to create AUTOREAD.  I
  1935.   figured that most text file manuals would follow a similar sort of
  1936.   format.  Alas!  It is now clear that there are as many styles of
  1937.   manual as there are authors.
  1938.  
  1939.   This makes creating a utility like this one which will be able to do
  1940.   such stuff as automatically creating chapter stops very difficult.
  1941.  
  1942.   It amazes me that some authors create manuals where the section
  1943.   headings are barely given ANY kind of distinction from the rest of the
  1944.   body text.  No underlinings, no section numberings, not even all in
  1945.   caps.  Surely this makes these manuals difficult to read even in a
  1946.   hard copy printout?
  1947.  
  1948.   The same goes (in spades) for different ways of indicating page
  1949.   numbers.
  1950.  
  1951.   I guess this is a (selfish) plea for well designed manuals that
  1952.   AUTOREAD will work well with!
  1953.  
  1954.                                                   Autoread Manual   -39-
  1955.  
  1956.   APPENDIX F: RAVE REVIEWS AND UNSOLICITED TESTIMONIALS!
  1957.   ══════════════════════════════════════════════════════
  1958.  
  1959.      "splendidly designed and immensely powerful...  this little gem...
  1960.       we'll bet you'll soon be in love with this splendid piece of
  1961.       shareware."
  1962.                  ----- "Boardwatch Magazine", November 1991:
  1963.  
  1964.      "Again thank you.  Your product is a life saver for me..."
  1965.                  ----- Shaw and Associates:
  1966.  
  1967.       "excellent product/idea!"
  1968.                  ----- Lowell D.King
  1969.  
  1970.       "You've invented a great concept!"
  1971.                  ----- Dan Pichulo
  1972.  
  1973.       "...very impressed...your idea of chapter location is an
  1974.        innovative feature..."
  1975.                 ----- Scott Robertson
  1976.  
  1977.